home *** CD-ROM | disk | FTP | other *** search
/ Visual Basic Source Code / Visual Basic Source Code.iso / vbsource / vbdatabs / cacheb.cpp < prev    next >
C/C++ Source or Header  |  1999-03-14  |  6KB  |  194 lines
  1. // ------------------------------- //
  2. // -------- Start of File -------- //
  3. // ------------------------------- //
  4. // ----------------------------------------------------------- // 
  5. // C++ Source Code File Name: cacheb.cpp 
  6. // Compiler Used: MSVC40, DJGPP 2.7.2.1, GCC 2.7.2.1, HP CPP 10.24
  7. // Produced By: Doug Gaer   
  8. // File Creation Date: 02/07/1997  
  9. // Date Last Modified: 03/15/1999
  10. // Copyright (c) 1997 Douglas M. Gaer
  11. // ----------------------------------------------------------- // 
  12. // ------------- Program Description and Details ------------- // 
  13. // ----------------------------------------------------------- // 
  14. /*
  15. The VBD C++ classes are copyright (c) 1997, by Douglas M. Gaer.
  16. All those who put this code or its derivatives in a commercial
  17. product MUST mention this copyright in their documentation for
  18. users of the products in which this code or its derivative
  19. classes are used. Otherwise, you have the freedom to redistribute
  20. verbatim copies of this source code, adapt it to your specific
  21. needs, or improve the code and release your improvements to the
  22. public provided that the modified files carry prominent notices
  23. stating that you changed the files and the date of any change.
  24.  
  25. THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND.
  26. THE ENTIRE RISK OF THE QUALITY AND PERFORMANCE OF THIS SOFTWARE
  27. IS WITH YOU. SHOULD ANY ELEMENT OF THIS SOFTWARE PROVE DEFECTIVE,
  28. YOU WILL ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR
  29. CORRECTION.
  30.  
  31. The Cacheb class is use as base class for the Cache class. It
  32. incorporates functions that are independent of the bucket type.
  33. The cache is used to handle requests for file-based objects. The
  34. cache must determine whether an object is already loaded. If the
  35. object is not loaded the cache reserves a bucket and loads the
  36. object into memory. This cache design uses cache pointers to
  37. reference cache buckets directly, with each cache pointer being
  38. initialized after the bucket is reserved. The least-recently
  39. reserved cache bucket is overwritten when the cache fills up.
  40. */
  41. // ----------------------------------------------------------- // 
  42. #include "cacheb.h"
  43. #include "bucketb.h"
  44.  
  45. Cacheb::Cacheb(Bucketb *b, int n, unsigned bkt_size)
  46. // Assumes n buckets of size bkt_size have already been
  47. // allocated. Sets up their Prior and Next pointers to form
  48. // a circular list.
  49. : fptr(0)
  50. {
  51.   Bucketb *p = b;
  52.   for (int i = 0; i<n; i++) {
  53.       p->MakeNull();
  54.       p->Prior = (Bucketb *)((char *)p - bkt_size);
  55.       p->Next = (Bucketb *)((char *)p + bkt_size);
  56.       p = p->Next;
  57.   }
  58.   // Make the list circular
  59.   Bucketb *tail = (Bucketb *)((char *)b + (n-1)*bkt_size);
  60.   tail->Next = b;
  61.   b->Prior = tail;
  62.   // Set up other cache variables
  63.   nbuckets = n; Head = b; 
  64.   Hits = 0; Misses = 0; FastBinds = 0;
  65. }
  66.  
  67. Cacheb::~Cacheb()
  68. {
  69.   // Destructor provided for virtuality
  70. }
  71.  
  72. void Cacheb::MoveToFront(Bucketb *b)
  73. // Logically move bucket to front of list, so that it is
  74. // treated as the most recently reserved bucket.
  75. {
  76.   if (b == Head->Prior) { // b is tail
  77.      Head = Head->Prior;
  78.   }
  79.   else if (b != Head) {
  80.     // Unhook bucket from where it is
  81.     b->Prior->Next = b->Next;
  82.     b->Next->Prior = b->Prior;
  83.     // Put it before Head
  84.     b->Next = Head;
  85.     b->Prior = Head->Prior;
  86.     b->Prior->Next = b;
  87.     Head->Prior = b;
  88.     Head = b;
  89.   }
  90. }
  91.  
  92. void Cacheb::Flush(int empty_bkts)
  93. // Flushes all buckets in the cache. Makes them empty if
  94. // empty_bkts is true. Checks for dangling cache pointers.
  95. {
  96.   // Flush, starting at the front
  97.   Bucketb *b = Head;
  98.   do {
  99.     if (empty_bkts && b->IsLocked())
  100. #ifdef CPP_EXCEPTIONS
  101.       throw CDanglingPtr();
  102. #else
  103.       Error->SignalException(EHandler::DanglingPtr);
  104. #endif
  105.  
  106.     if (fptr->ReadyForWriting()) b->Flush(*fptr);
  107.     if (empty_bkts) b->MakeNull();
  108.     b = b->Next;
  109.   } while(b != Head);
  110. }
  111.  
  112. void Cacheb::Clear()
  113. // Flush all buckets in the cache, and then null them out.
  114. // An exception is thrown if any dangling cache pointers are found.
  115. {
  116.   if (fptr) Flush(1);
  117.   Hits = 0; Misses = 0; FastBinds = 0;
  118. }
  119.  
  120. Bucketb *Cacheb::AcquireBkt()
  121. // Finds least recently reserved bucket that isn't locked,
  122. // flushes the bucket, and moves it to the front. Passes
  123. // back pointer to bucket or returns 0 if no bucket available.
  124. {
  125.   Bucketb *b = Head->Prior; // Least-recently reserved bucket
  126.   while(1) {
  127.     if (!b->IsLocked()) break;
  128.     b = b->Prior;
  129.     if (b == Head->Prior) {
  130. #ifdef CPP_EXCPETIONS
  131.       throw CCacheFull();
  132. #else
  133.       Error->SignalException(EHandler::CacheFull);
  134. #endif
  135.        return 0;            
  136.     }
  137.   }
  138.   // Flush any data that might be in the bucket and move it to
  139.   // the front so it becomes the most-recently reserved bucket.
  140.   b->Flush(*fptr);
  141.   MoveToFront(b);
  142.   return b;
  143. }
  144.  
  145. Bucketb *Cacheb::FindBkt(FAU Address)
  146. // Searches for a bucket in the cache connected to file address.
  147. // Returns pointer or 0 if the bucket is not found.
  148. {
  149.   // Start search from front, (most recently reserved bucket)
  150.   Bucketb *b = Head;
  151.   do {
  152.     if (b->Address == Address) return b;
  153.     b = b->Next;
  154.   } while(b != Head);
  155.   return 0;
  156. }
  157.  
  158. Bucketb *Cacheb::ReserveBkt(FAU Address, int ensure_loaded)
  159. // Reserves a bucket for file address. If ensure_loaded == 1,
  160. // then if the data at the address is not already in bucket,
  161. // and is loaded in. Moves bucket to the front and passes back
  162. // a pointer to bucket, which may be 0 if there is an error.
  163. {
  164.   Bucketb *b;
  165.  
  166.   if (Address == 0) return 0; // No sense reserving bucket
  167.  
  168.   b = FindBkt(Address);
  169.   if (b == 0) { // Bkt data not loaded, so acquire a bucket
  170.      Misses++;
  171.      b = AcquireBkt();
  172.      if (b) {
  173.         b->Address = Address;
  174.         if (ensure_loaded && Address) {
  175.            b->Fetch(*fptr);
  176.         }
  177.         // If failure fetching data, return null bucket to
  178.         // signal failure, else lock the bucket.
  179.         if (!fptr->IsOK()) b = 0; else b->Lock();
  180.      }
  181.   }
  182.   else {
  183.     Hits++;
  184.     MoveToFront(b);
  185.     b->Lock();
  186.   }
  187.  
  188.   return b;
  189. }
  190. // ----------------------------------------------------------- //
  191. // ------------------------------- //
  192. // --------- End of File --------- //
  193. // ------------------------------- //
  194.